<!DOCTYPE HTML>

<html lang="en">
<head>

<title>Saml2AuthenticationToken (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Saml2AuthenticationToken (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":42,"i3":42,"i4":10,"i5":42,"i6":10,"i7":10,"i8":42,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="Saml2AuthenticationToken.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.saml2.provider.service.authentication</a></div>
<h2 title="Class Saml2AuthenticationToken" class="title">Class Saml2AuthenticationToken</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../authentication/AbstractAuthenticationToken.html" title="class in org.springframework.security.authentication">org.springframework.security.authentication.AbstractAuthenticationToken</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationToken</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.security.Principal</code>, <code><a href="../../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code>, <code><a href="../../../../core/CredentialsContainer.html" title="interface in org.springframework.security.core">CredentialsContainer</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Saml2AuthenticationToken</span>
extends <a href="../../../../authentication/AbstractAuthenticationToken.html" title="class in org.springframework.security.authentication">AbstractAuthenticationToken</a></pre>
<div class="block">Represents an incoming SAML 2.0 response containing an assertion that has not been
validated. <a href="Saml2AuthenticationToken.html#isAuthenticated()"><code>isAuthenticated()</code></a> will always return false.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationToken">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.List)">Saml2AuthenticationToken</a></span>&#8203;(java.lang.String&nbsp;saml2Response,
java.lang.String&nbsp;recipientUri,
java.lang.String&nbsp;idpEntityId,
java.lang.String&nbsp;localSpEntityId,
java.util.List&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;&nbsp;credentials)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="Saml2AuthenticationToken.html#%3Cinit%3E(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String)"><code>Saml2AuthenticationToken(RelyingPartyRegistration, String)</code></a>
instead</div>
</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#%3Cinit%3E(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String)">Saml2AuthenticationToken</a></span>&#8203;(<a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;relyingPartyRegistration,
java.lang.String&nbsp;saml2Response)</code></th>
<td class="colLast">
<div class="block">Creates a <a href="Saml2AuthenticationToken.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationToken</code></a> with the provided parameters
Note that the given <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> should have all its templates
resolved at this point.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#%3Cinit%3E(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String,org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest)">Saml2AuthenticationToken</a></span>&#8203;(<a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;relyingPartyRegistration,
java.lang.String&nbsp;saml2Response,
<a href="AbstractSaml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">AbstractSaml2AuthenticationRequest</a>&nbsp;authenticationRequest)</code></th>
<td class="colLast">
<div class="block">Creates a <a href="Saml2AuthenticationToken.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationToken</code></a> with the provided parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="AbstractSaml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">AbstractSaml2AuthenticationRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getAuthenticationRequest()">getAuthenticationRequest</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the authentication request sent to the assertion party or <code>null</code> if
no authentication request is present</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getCredentials()">getCredentials</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the decoded and inflated SAML 2.0 Response XML object as a string</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getIdpEntityId()">getIdpEntityId</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use
<code>getRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()</code>
instead</div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getLocalSpEntityId()">getLocalSpEntityId</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <code>getRelyingPartyRegistration().getEntityId()</code> instead</div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getPrincipal()">getPrincipal</a></span>()</code></th>
<td class="colLast">
<div class="block">Always returns null.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getRecipientUri()">getRecipientUri</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use
<code>getRelyingPartyRegistration().getAssertionConsumerServiceLocation()</code> instead</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getRelyingPartyRegistration()">getRelyingPartyRegistration</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the resolved <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> associated with the request</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getSaml2Response()">getSaml2Response</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns inflated and decoded XML representation of the SAML 2 Response</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#getX509Credentials()">getX509Credentials</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Get the credentials through <a href="Saml2AuthenticationToken.html#getRelyingPartyRegistration()"><code>getRelyingPartyRegistration()</code></a>
instead</div>
</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#isAuthenticated()">isAuthenticated</a></span>()</code></th>
<td class="colLast">
<div class="block">Used to indicate to <code>AbstractSecurityInterceptor</code> whether it should present
the authentication token to the <code>AuthenticationManager</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationToken.html#setAuthenticated(boolean)">setAuthenticated</a></span>&#8203;(boolean&nbsp;authenticated)</code></th>
<td class="colLast">
<div class="block">The state of this object cannot be changed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.authentication.AbstractAuthenticationToken">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.authentication.<a href="../../../../authentication/AbstractAuthenticationToken.html" title="class in org.springframework.security.authentication">AbstractAuthenticationToken</a></h3>
<code><a href="../../../../authentication/AbstractAuthenticationToken.html#equals(java.lang.Object)">equals</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#eraseCredentials()">eraseCredentials</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#getAuthorities()">getAuthorities</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#getDetails()">getDetails</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#getName()">getName</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#hashCode()">hashCode</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#setDetails(java.lang.Object)">setDetails</a>, <a href="../../../../authentication/AbstractAuthenticationToken.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.security.Principal">

</a>
<h3>Methods inherited from interface&nbsp;java.security.Principal</h3>
<code>implies</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String,org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>Saml2AuthenticationToken</h4>
<pre>public&nbsp;Saml2AuthenticationToken&#8203;(<a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;relyingPartyRegistration,
                                java.lang.String&nbsp;saml2Response,
                                <a href="AbstractSaml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">AbstractSaml2AuthenticationRequest</a>&nbsp;authenticationRequest)</pre>
<div class="block">Creates a <a href="Saml2AuthenticationToken.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationToken</code></a> with the provided parameters.
Note that the given <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> should have all its templates
resolved at this point. See
<a href="../servlet/filter/Saml2WebSsoAuthenticationFilter.html" title="class in org.springframework.security.saml2.provider.service.servlet.filter"><code>Saml2WebSsoAuthenticationFilter</code></a>
for an example of performing that resolution.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>relyingPartyRegistration</code> - the resolved <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> to
use</dd>
<dd><code>saml2Response</code> - the SAML 2.0 response to authenticate</dd>
<dd><code>authenticationRequest</code> - the <code>AuthNRequest</code> sent to the asserting party</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>Saml2AuthenticationToken</h4>
<pre>public&nbsp;Saml2AuthenticationToken&#8203;(<a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;relyingPartyRegistration,
                                java.lang.String&nbsp;saml2Response)</pre>
<div class="block">Creates a <a href="Saml2AuthenticationToken.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationToken</code></a> with the provided parameters
Note that the given <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> should have all its templates
resolved at this point. See
<a href="../servlet/filter/Saml2WebSsoAuthenticationFilter.html" title="class in org.springframework.security.saml2.provider.service.servlet.filter"><code>Saml2WebSsoAuthenticationFilter</code></a>
for an example of performing that resolution.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>relyingPartyRegistration</code> - the resolved <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> to
use</dd>
<dd><code>saml2Response</code> - the SAML 2.0 response to authenticate</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.List)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Saml2AuthenticationToken</h4>
<pre>@Deprecated
public&nbsp;Saml2AuthenticationToken&#8203;(java.lang.String&nbsp;saml2Response,
                                java.lang.String&nbsp;recipientUri,
                                java.lang.String&nbsp;idpEntityId,
                                java.lang.String&nbsp;localSpEntityId,
                                java.util.List&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;&nbsp;credentials)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="Saml2AuthenticationToken.html#%3Cinit%3E(org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration,java.lang.String)"><code>Saml2AuthenticationToken(RelyingPartyRegistration, String)</code></a>
instead</div>
</div>
<div class="block">Creates an authentication token from an incoming SAML 2 Response object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>saml2Response</code> - inflated and decoded XML representation of the SAML 2 Response</dd>
<dd><code>recipientUri</code> - the URL that the SAML 2 Response was received at. Used for
validation</dd>
<dd><code>idpEntityId</code> - the entity ID of the asserting entity</dd>
<dd><code>localSpEntityId</code> - the configured local SP, the relying party, entity ID</dd>
<dd><code>credentials</code> - the credentials configured for signature verification and
decryption</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="getCredentials()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentials</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;getCredentials()</pre>
<div class="block">Returns the decoded and inflated SAML 2.0 Response XML object as a string</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>decoded and inflated XML data as a <code>String</code></dd>
</dl>
</li>
</ul>
<a id="getPrincipal()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrincipal</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;getPrincipal()</pre>
<div class="block">Always returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null</dd>
</dl>
</li>
</ul>
<a id="getRelyingPartyRegistration()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelyingPartyRegistration</h4>
<pre class="methodSignature">public&nbsp;<a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;getRelyingPartyRegistration()</pre>
<div class="block">Get the resolved <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a> associated with the request</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resolved <a href="../registration/RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="getSaml2Response()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getSaml2Response</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getSaml2Response()</pre>
<div class="block">Returns inflated and decoded XML representation of the SAML 2 Response</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>inflated and decoded XML representation of the SAML 2 Response</dd>
</dl>
</li>
</ul>
<a id="getRecipientUri()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecipientUri</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String&nbsp;getRecipientUri()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use
<code>getRelyingPartyRegistration().getAssertionConsumerServiceLocation()</code> instead</div>
</div>
<div class="block">Returns the URI that the SAML 2 Response object came in on</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URI as a string</dd>
</dl>
</li>
</ul>
<a id="getLocalSpEntityId()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalSpEntityId</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String&nbsp;getLocalSpEntityId()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <code>getRelyingPartyRegistration().getEntityId()</code> instead</div>
</div>
<div class="block">Returns the configured entity ID of the receiving relying party, SP</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an entityID for the configured local relying party</dd>
</dl>
</li>
</ul>
<a id="getX509Credentials()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getX509Credentials</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.util.List&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;&nbsp;getX509Credentials()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Get the credentials through <a href="Saml2AuthenticationToken.html#getRelyingPartyRegistration()"><code>getRelyingPartyRegistration()</code></a>
instead</div>
</div>
<div class="block">Returns all the credentials associated with the relying party configuraiton</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all associated credentials</dd>
</dl>
</li>
</ul>
<a id="isAuthenticated()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>isAuthenticated</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAuthenticated()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../core/Authentication.html#isAuthenticated()">Authentication</a></code></span></div>
<div class="block">Used to indicate to <code>AbstractSecurityInterceptor</code> whether it should present
the authentication token to the <code>AuthenticationManager</code>. Typically an
<code>AuthenticationManager</code> (or, more often, one of its
<code>AuthenticationProvider</code>s) will return an immutable authentication token
after successful authentication, in which case that token can safely return
<code>true</code> to this method. Returning <code>true</code> will improve
performance, as calling the <code>AuthenticationManager</code> for every request
will no longer be necessary.
<p>
For security reasons, implementations of this interface should be very careful
about returning <code>true</code> from this method unless they are either
immutable, or have some way of ensuring the properties have not been changed since
original creation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../core/Authentication.html#isAuthenticated()">isAuthenticated</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../authentication/AbstractAuthenticationToken.html#isAuthenticated()">isAuthenticated</a></code>&nbsp;in class&nbsp;<code><a href="../../../../authentication/AbstractAuthenticationToken.html" title="class in org.springframework.security.authentication">AbstractAuthenticationToken</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false</dd>
</dl>
</li>
</ul>
<a id="setAuthenticated(boolean)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthenticated</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAuthenticated&#8203;(boolean&nbsp;authenticated)</pre>
<div class="block">The state of this object cannot be changed. Will always throw an exception</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../core/Authentication.html#setAuthenticated(boolean)">setAuthenticated</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../authentication/AbstractAuthenticationToken.html#setAuthenticated(boolean)">setAuthenticated</a></code>&nbsp;in class&nbsp;<code><a href="../../../../authentication/AbstractAuthenticationToken.html" title="class in org.springframework.security.authentication">AbstractAuthenticationToken</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authenticated</code> - ignored</dd>
</dl>
</li>
</ul>
<a id="getIdpEntityId()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdpEntityId</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String&nbsp;getIdpEntityId()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use
<code>getRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()</code>
instead</div>
</div>
<div class="block">Returns the configured IDP, asserting party, entity ID</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representing the entity ID</dd>
</dl>
</li>
</ul>
<a id="getAuthenticationRequest()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthenticationRequest</h4>
<pre class="methodSignature">public&nbsp;<a href="AbstractSaml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">AbstractSaml2AuthenticationRequest</a>&nbsp;getAuthenticationRequest()</pre>
<div class="block">Returns the authentication request sent to the assertion party or <code>null</code> if
no authentication request is present</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authentication request sent to the assertion party</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="Saml2AuthenticationToken.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationToken.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040ccf97bb0980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
